<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>console.example</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="console-module.html">Package&nbsp;console</a> ::
        Module&nbsp;example
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="console.example-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module example</h1><p class="nomargin-top"><span class="codelink"><a href="console.example-pysrc.html">source&nbsp;code</a></span></p>
<p>Example of using the console framework.</p>
  <h1 class="heading">Overview</h1>
    <p>This code represents a standard methodology for programming console 
    programs using the <a href="console-module.html" 
    class="link">console</a> framework. Essentially, external functionality
    is imported from other modules, and commands are entry points to that 
    functionality. Extend the <a 
    href="console.interactive.InteractiveShell-class.html" 
    class="link">InteractiveShell</a> and add custom commands either as 
    internal private classes, or as their own class hierarchy, and then add
    them during <a href="console.example.CustomShell-class.html#__init__" 
    class="link">CustomShell.__init__</a>.</p>
    <p>Good luck, and good coding!</p>
  <h1 class="heading">Class Hierarchy</h1>
    <p></p>
<center><table border="0" cellpadding="0" cellspacing="0" class="graph">
  <tr><td align="center">
  <map id="class_hierarchy_for_customshel" name="class_hierarchy_for_customshel">
<area shape="rect" href="console.example.CustomShell-class.html" title="CustomShell" alt="" coords="5,5,101,32"/>
<area shape="rect" href="console.example.CustomShell._CustomCommand-class.html" title="CustomShell._CustomCommand" alt="" coords="125,5,336,32"/>
<area shape="rect" href="console.interactive.InteractiveCommand-class.html" title="interactive.InteractiveCommand" alt="" coords="360,5,560,32"/>
<area shape="rect" href="console.interactive.InteractiveShell-class.html" title="interactive.InteractiveShell" alt="" coords="584,5,755,32"/>
</map>
  <img src="class_hierarchy_for_customshel.gif" alt='Class Hierarchy for CustomShell and CustomShell._CustomCommand' usemap="#class_hierarchy_for_customshel" ismap="ismap" class="graph-with-title" />
  </td></tr>
  <tr><td align='center'>
<span class="graph-title">Class Hierarchy for CustomShell and CustomShell._CustomCommand</span>
  </td></tr>
</table><br /></center>    <p></p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        <a href="mailto:bbengfort@tacnetsol.com" target="_top">Benjamin 
        Bengfort</a>
      </p>
      <p><strong>Organization:</strong>
        Tactical Network Solutions
      </p>
      <p><strong>License:</strong>
        Open Source MIT License
      </p>
      <p><strong>Copyright:</strong>
        &copy; 2010 Tactical Network Solutions
      </p>
      <p><strong>Requires:</strong>
        Python 2.6
      </p>
      <p><strong>Version:</strong>
        1.0
      </p>
      <p><strong>Change Log:</strong>
        <i>example.py 2 2010-11-29 13:48:00 -0400 bbengfort</i>
      </p>
      <p><strong>Since:</strong>
        2010-11-29 17:20:39 -0400
      </p>
      <p><strong>To Do:</strong>
        Create other examples folder
      </p>
</div><!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="console.example.CustomShell-class.html" class="summary-name">CustomShell</a>
    </td>
  </tr>
</table>
<p class="indent-wrapped-lines"><b>Imports:</b>
  <a href="console.interactive.InteractiveCommand-class.html" title="console.interactive.InteractiveCommand">InteractiveCommand</a>,
  <a href="console.interactive.InteractiveShell-class.html" title="console.interactive.InteractiveShell">InteractiveShell</a>
</p><br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="console-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/console/">console</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Tue Nov 30 11:33:30 2010
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
